Skip to content

Generate html manuals in extractManuals #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 1 commit into
base: devel
Choose a base branch
from
Draft

Generate html manuals in extractManuals #17

wants to merge 1 commit into from

Conversation

jwokaty
Copy link
Contributor

@jwokaty jwokaty commented Feb 4, 2025 •
edited
Loading

May alternatively fulfill creating html manuals mentioned in #15. Creates html manual in the same function as the pdf manual and places it in the pkg/man/pkg.html path.

Note: This doesn't seem to be the way that manuals are created anymore although there's some cruft in the BBS code pointing to it. Keeping for referencing temporarily.

@jwokaty jwokaty self-assigned this Feb 4, 2025
@jwokaty jwokaty force-pushed the extractManuals-with-html branch from 86caf47 to 2442031 Compare February 4, 2025 14:30
@jwokaty jwokaty marked this pull request as draft February 5, 2025 15:14
@LiNk-NY
Copy link
Contributor

LiNk-NY commented Feb 6, 2025

Hi Andres, @jwokaty

I reviewed the code and the proposed change.
The code written here only works for data/annotation packages which should come shipped with PDF manuals (as we don't build them with the BBS).
Perhaps Lori @lshep can provide more context but the current proposed changes in this PR would only affect annotation packages and not all the software packages as intended.

@jwokaty
Copy link
Contributor Author

jwokaty commented Feb 6, 2025 •
edited
Loading

@LiNk-NY Thanks for looking at this. I realized that it doesn't work for all packages and it may not be used by the BBS anymore. Software manuals (data experiment and maybe some annotations too) are pulled from R.check folders, which is done during the BBS postrun so I am making changes there Bioconductor/BBS#438. I put this in WIP until I can assess if this is still being used. Maybe it's only used for the packages that aren't built by the BBS?

@jwokaty jwokaty marked this pull request as ready for review February 10, 2025 18:21
@jwokaty jwokaty mentioned this pull request Feb 10, 2025
Open
@jwokaty jwokaty marked this pull request as draft May 1, 2025 12:29
@jwokaty jwokaty marked this pull request as draft May 1, 2025 12:29
@jwokaty jwokaty marked this pull request as draft May 1, 2025 12:29
@jwokaty jwokaty marked this pull request as draft May 1, 2025 12:29
@jwokaty jwokaty marked this pull request as draft May 1, 2025 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jwokaty jwokaty

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jwokaty @LiNk-NY